PortOne Server SDK for JVM/io.portone.sdk.server.common

Package-level declarations

Types

Address

@Serializable

sealed interface Address

분리 형식 주소

Bank

@Serializable

enum Bank : Enum<Bank>

은행

BillingKeyPaymentInput

@Serializable

data class BillingKeyPaymentInput(val billingKey: String, val orderName: String, val amount: PaymentAmountInput, val currency: Currency, val storeId: String? = null, val channelKey: String? = null, val customer: CustomerInput? = null, val customData: String? = null, val installmentMonth: Int? = null, val useFreeInterestFromMerchant: Boolean? = null, val useCardPoint: Boolean? = null, val cashReceipt: CashReceiptInput? = null, val country: Country? = null, val noticeUrls: List<String>? = null, val products: List<PaymentProduct>? = null, val productCount: Int? = null, val productType: PaymentProductType? = null, val shippingAddress: SeparatedAddressInput? = null, val promotionId: String? = null, val bypass: JsonObject? = null)

빌링키 결제 요청 입력 정보

Card

@Serializable

data class Card(val publisher: String? = null, val issuer: String? = null, val brand: CardBrand? = null, val type: CardType? = null, val ownerType: CardOwnerType? = null, val bin: String? = null, val name: String? = null, val number: String? = null)

카드 상세 정보

CardBrand

@Serializable

enum CardBrand : Enum<CardBrand>

카드 브랜드

CardCredential

@Serializable

data class CardCredential(val number: String, val expiryYear: String, val expiryMonth: String, val birthOrBusinessRegistrationNumber: String? = null, val passwordTwoDigits: String? = null)

카드 인증 관련 정보

CardOwnerType

@Serializable

enum CardOwnerType : Enum<CardOwnerType>

카드 소유주 유형

CardType

@Serializable

enum CardType : Enum<CardType>

카드 유형

CashReceiptInput

@Serializable

data class CashReceiptInput(val type: CashReceiptInputType, val customerIdentityNumber: String? = null)

현금영수증 입력 정보

CashReceiptInputType

@Serializable

enum CashReceiptInputType : Enum<CashReceiptInputType>

입력 시 발급 유형

CashReceiptType

@Serializable

enum CashReceiptType : Enum<CashReceiptType>

발급 유형

ChannelGroupSummary

@Serializable

data class ChannelGroupSummary(val id: String, val name: String, val isForTest: Boolean)

채널 그룹 정보

Country

@Serializable

enum Country : Enum<Country>

국가

Currency

@Serializable

enum Currency : Enum<Currency>

통화 단위

Customer

@Serializable

data class Customer(val id: String? = null, val name: String? = null, val birthYear: String? = null, val gender: Gender? = null, val email: String? = null, val phoneNumber: String? = null, val address: Address? = null, val zipcode: String? = null)

고객 정보

CustomerInput

@Serializable

data class CustomerInput(val id: String? = null, val name: CustomerNameInput? = null, val birthYear: String? = null, val birthMonth: String? = null, val birthDay: String? = null, val country: Country? = null, val gender: Gender? = null, val email: String? = null, val phoneNumber: String? = null, val address: SeparatedAddressInput? = null, val zipcode: String? = null, val businessRegistrationNumber: String? = null)

고객 정보 입력 정보

CustomerNameInput

@Serializable

data class CustomerNameInput(val full: String? = null, val separated: CustomerSeparatedName? = null)

고객 이름 입력 정보

CustomerSeparatedName

@Serializable

data class CustomerSeparatedName(val first: String, val last: String)

고객 분리형 이름

DateTimeRange

@Serializable

data class DateTimeRange(val from: @Serializable(with = InstantSerializer::class) Instant, val until: @Serializable(with = InstantSerializer::class) Instant)

시간 범위

DayOfWeek

@Serializable

enum DayOfWeek : Enum<DayOfWeek>

요일

EasyPayProvider

@Serializable

enum EasyPayProvider : Enum<EasyPayProvider>

간편 결제사

Gender

@Serializable

enum Gender : Enum<Gender>

성별

OneLineAddress

@Serializable

@SerialName(value = "ONE_LINE")

data class OneLineAddress(val oneLine: String) : Address

한 줄 형식 주소

PageInfo

@Serializable

data class PageInfo(val number: Int, val size: Int, val totalCount: Int)

반환된 페이지 결과 정보

PageInput

@Serializable

data class PageInput(val number: Int? = null, val size: Int? = null)

다건 조회 API 에 사용되는 페이지 입력 정보

PaymentAmountInput

@Serializable

data class PaymentAmountInput(val total: Long, val taxFree: Long? = null, val vat: Long? = null)

금액 세부 입력 정보

PaymentClientType

@Serializable

enum PaymentClientType : Enum<PaymentClientType>

결제가 발생한 클라이언트 환경

PaymentMethodType

@Serializable

enum PaymentMethodType : Enum<PaymentMethodType>

PaymentProduct

@Serializable

data class PaymentProduct(val id: String, val name: String, val amount: Long, val quantity: Int, val tag: String? = null, val code: String? = null)

상품 정보

PaymentProductType

@Serializable

enum PaymentProductType : Enum<PaymentProductType>

상품 유형

PaymentStatus

@Serializable

enum PaymentStatus : Enum<PaymentStatus>

결제 건 상태

PgCompany

@Serializable

enum PgCompany : Enum<PgCompany>

PG사

PgProvider

@Serializable

enum PgProvider : Enum<PgProvider>

PG사 결제 모듈

PortOneVersion

@Serializable

enum PortOneVersion : Enum<PortOneVersion>

포트원 버전

SelectedChannel

@Serializable

data class SelectedChannel(val type: SelectedChannelType, val pgProvider: PgProvider, val pgMerchantId: String, val id: String? = null, val key: String? = null, val name: String? = null)

(결제, 본인인증 등에) 선택된 채널 정보

SelectedChannelType

@Serializable

enum SelectedChannelType : Enum<SelectedChannelType>

채널 타입

SeparatedAddress

@Serializable

@SerialName(value = "SEPARATED")

data class SeparatedAddress(val oneLine: String, val addressLine1: String, val addressLine2: String, val city: String? = null, val province: String? = null, val country: Country? = null) : Address

분리 형식 주소

SeparatedAddressInput

@Serializable

data class SeparatedAddressInput(val addressLine1: String, val addressLine2: String, val city: String? = null, val province: String? = null, val country: Country? = null)

분리 형식 주소 입력 정보

SortOrder

@Serializable

enum SortOrder : Enum<SortOrder>

정렬 방식